BaseSubsystem.GetVariable method

Gets the details of a user-defined variable.

Namespace: IntervalZero.KINGSTAR.Base.Class

Assembly: IntervalZero.KINGSTAR.Base.Class (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

IUserVariable GetVariable(
       string Name,
       IUserVariable Parent = null
)

Function GetVariable(
       Name As String,
       Parent = null As IUserVariable
) As IUserVariable

Parameters

Name

Type: string

The name of a variable.

Parent

Type: IUserVariable

Default value: null

The parent folder of IUserVariable. By default, it gets variables from the root folder.

Remarks

• The Name string uses UTF-16 encoding.
• The variable can be used in KINGSTAR Scope and a real-time log.

Return value

Type: IUserVariable

Returns a user-defined variable.

Usable EtherCAT states

ecatOffline, ecatInit, ecatBoot, ecatPreOP, ecatSafeOP, ecatOP

See also

BaseSubsystem Class

IntervalZero.KINGSTAR.Base.Class Namespace